Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] adds feedback component #8507

Merged
merged 5 commits into from
Jul 22, 2019
Merged

[docs] adds feedback component #8507

merged 5 commits into from
Jul 22, 2019

Conversation

katydecorah
Copy link
Contributor

@katydecorah katydecorah commented Jul 18, 2019

This PR adds a feedback component to bottom of pages and sections. This component is currently on all docs.mapbox.com sites and it looks like this:

image

The component will appear at the end of:

  • /mapbox-gl-js/overview/
  • each subsection in /mapbox-gl-js/api/
  • each example at /mapbox-gl-js/example/*/
  • each section /mapbox-gl-js/style-spec/

Note: since the Style spec's subsections tend to be shorter than subsections on the API page, we decided to only place the component at the end of each Style spec section.

After the launch of this final site, look out for an internal post from the docs team where we'll share how teams can review ratings for given sites and pages. We'll also share how the docs team is triaging this feedback on a daily basis.

Ref https://github.com/mapbox/documentation/issues/209

Launch Checklist

  • briefly describe the changes in this PR
  • check with gl-js team before merging since this PR makes changes to yarn.lock

How to test

  1. yarn run start-docs
  2. click yes/no on one of the feedback components
  3. open the Segment mapbox-staging debugger and search for "sent docs feedback" to see if your events came through (events should come through regardless of ad blocker)

Katy DeCorah added 4 commits July 10, 2019 15:51
* publisher-production:
  [docs] fix SDK support for symbol-sort-key (#8501)
  v1.1.1
  fix #8481, unbounded memory growth in IE (#8490)
  fix race condition between caching and aborting (#8472)
  swap map-tiles example to use https (#8482)
  set antialias to true for custom layers and extrusion examples (#8474)
  update examples to use mapbox-gl-geocoder v4.4.1 (#8451)
  manually strip urls for faster cache matching (#8434) (#8449)
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the components look good to me and I tested that events are being sent. There are few that seem just a little odd (an example of a couple very short sections below), but that's just the nature of the content so I think it's ok!

Screen Shot 2019-07-18 at 12 38 47 PM

Copy link
Contributor

@HeyStenson HeyStenson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 Looks good, and events are being reported correctly!

@katydecorah
Copy link
Contributor Author

👋 @mapbox/gl-js this is ready to go, but we wanted to be mindful of merging since this PR makes changes to yarn.lock. Should we wait to merge or is it ok to merge it today?

@ryanhamley
Copy link
Contributor

@katydecorah can we wait until Monday to merge this? we're working on creating a new release and having some issues with merging publisher-production and master but that should be completed today

@katydecorah
Copy link
Contributor Author

can we wait until Monday to merge this?

@ryanhamley definitely! I'll check back in on Monday

@katydecorah
Copy link
Contributor Author

@ryanhamley are we clear to merge this today?

@ryanhamley
Copy link
Contributor

Yep you're good to go @katydecorah thanks!

@katydecorah katydecorah merged commit 81d72a7 into publisher-production Jul 22, 2019
@katydecorah katydecorah deleted the feedback branch July 22, 2019 18:48
mourner added a commit that referenced this pull request Jul 30, 2019
* origin/publisher-production:
  update version to v1.2.0 (#8562)
  Fix usage of String.includes which is es6 but not transformed by buble (#8565) (#8573)
  [docs] fix missing location prop to feedback component (#8554)
  Fix typo
  [docs] update dr-ui (#8548)
  [docs] fix errors on IE11 caused by dr-ui dependencies (#8544)
  updates directions plugin version (#8536)
  add dds sdk support
  squash (#8529)
  [docs] adds feedback component (#8507)
mourner pushed a commit that referenced this pull request Jul 30, 2019
* [docs] add feedback component

* Update dr-ui

* eslint

* update dr-ui, fixes mapbox/dr-ui#157
mourner pushed a commit that referenced this pull request Jul 30, 2019
* [docs] add feedback component

* Update dr-ui

* eslint

* update dr-ui, fixes mapbox/dr-ui#157
mourner pushed a commit that referenced this pull request Jul 30, 2019
* [docs] add feedback component

* Update dr-ui

* eslint

* update dr-ui, fixes mapbox/dr-ui#157
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants